/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * <http://www.mongodb.com/licensing/server-side-public-license>.
 */
package org.graylog.plugins.views.search.explain;

import java.util.Set;

/**
 * An interface that provides information on whether other stream-based databases are affected by the executed query.
 *
 */
public interface StreamQueryExplainer {
    /**
     * Generate a backend-specific query out of the logical query structure.
     *
     * @param streamQueryInfo holds stream relevant query information
     * @return a set of streams that were routed to another destination then es/os
     */
    Set<DataRoutedStream> explain(StreamQueryInfo streamQueryInfo);
}
